// --------------------------------------------------------------------------------------------------------------------
// <copyright file="VideoFrame.cs" company="Microsoft Corporation">
// The MIT License (MIT)
// 
// Copyright (c) 2014, Microsoft Corporation
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
//  of this software and associated documentation files (the "Software"), to deal
//  in the Software without restriction, including without limitation the rights
//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
//  copies of the Software, and to permit persons to whom the Software is
//  furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
//  all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
//  THE SOFTWARE.
// </copyright>
// --------------------------------------------------------------------------------------------------------------------
namespace Microsoft.Robotics.Visualization
{
    using System;
    using System.Drawing;

    /// <summary>
    /// The set of known pixel formats. This enum exists to avoid dragging in PresentationCore.dll, where the PixelFormat class is defined.
    /// </summary>
    public enum SimplePixelFormat
    {
        /// <summary>
        /// 8-bit gray levels. The data buffer is expected to be byte[]. 
        /// </summary>
        Gray8, 

        /// <summary>
        /// 16-bit gray levels. The data buffer is expected to be short[]. 
        /// </summary>
        Gray16, 

        /// <summary>
        /// 24-bit RGB. The data buffer is expected to be byte[].
        /// </summary>
        Rgb24,

        /// <summary>
        /// 32-bit BGRA. The data buffer is expected to be byte[].
        /// </summary>
        Bgra32
    }

    /// <summary>
    /// Groups the video frame data with a description of the video format used
    /// </summary>
    public struct VideoFrame
    {
        /// <summary>
        /// The buffer containing the frame pixels
        /// </summary>
        public Array Data;

        /// <summary>
        /// The image format of the data in the buffer
        /// </summary>
        public SimplePixelFormat Format;

        /// <summary>
        /// The size of the frame
        /// </summary>
        public Size Size;

        /// <summary>
        /// The stride (row length) of the input buffer, in bytes.
        /// </summary>
        public int Stride;
    }
}
